Appliance Update Policy Info

Appliance Update Policy Info
Appliance Update Policy Info

The Appliance Update Policy Info schema defines automatic update checking and staging policy.

This schema was added in vSphere API 6.7.

JSON Example
{
    "custom_url": "string",
    "default_url": "string",
    "username": "string",
    "check_schedule": [
        {
            "day": "string",
            "hour": 0,
            "minute": 0
        }
    ],
    "auto_stage": false,
    "auto_update": false,
    "manual_control": false,
    "certificate_check": false
}
string
custom_url
Optional

Current appliance update custom repository URL.

This property was added in vSphere API 6.7.

If missing or null update is checked at defaut URL.

string
default_url
Required

Current appliance update default repository URL.

This property was added in vSphere API 6.7.

string
username
Optional

Username for the update repository

This property was added in vSphere API 6.7.

If missing or null username will not be used to login

array of Appliance Update Policy Time
check_schedule
Required

Schedule when the automatic check will be run.

This property was added in vSphere API 6.7.

boolean
auto_stage
Required

Automatically stage the latest update if available.

This property was added in vSphere API 6.7.

boolean
auto_update
Required

Is the appliance updated automatically. If set the appliance may ignore the check schedule or auto-stage settings.

This property was added in vSphere API 6.7.

boolean
manual_control
Required

Whether API client should allow the user to start update manually

This property was added in vSphere API 6.7.

boolean
certificate_check
Required

Indicates whether certificates will be checked during patching.

Warning: If this property is set to false, an insecure connection is made to the update repository which can potentially put the appliance security at risk.

This property was added in vSphere API 6.7.

Returned By